Expand cspell ignore instructions #2252
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Eric Arellano <[email protected]>
README.md
Outdated
| @@ -309,7 +309,7 @@ npm run check | |||
|
|
|||
| There are two ways to deal with cSpell incorrectly complaining about a word, such as abbreviations. | |||
|
|
|||
| 1. Ignore the word in the local markdown file by adding a comment to the file, like below. The word is not case-sensitive, and the comment can be placed anywhere. | |||
| 1. Ignore the word in the local markdown file by adding a comment to the file, like below. The word is not case-sensitive, and the comment can be placed anywhere (inside a markdown cell, in the source part). Note that in the text editor, each line is surrounded by quotes and ends with /n. So it looks like this: "{/* cspell:ignore hellllooooo, ayyyyy */}/n" | |||
There was a problem hiding this comment.
These new instructions only apply if it's a Jupyter notebook. I recommend something like this:
If the file is a Jupyter notebook, add the comment inside a markdown cell in the source part. Each line should be surrounded by quotes and end with \n.
Then you could add a second example code block with the language set to json:
{
"cell_type": "markdown",
"id": "552b1077",
"metadata": {},
"source": [
"# Hello world\n",
"{/* cspell:ignore helloooooo */}\n"
]
},
There was a problem hiding this comment.
Suggested change
| 1. Ignore the word in the local markdown file by adding a comment to the file, like below. The word is not case-sensitive, and the comment can be placed anywhere (inside a markdown cell, in the source part). Note that in the text editor, each line is surrounded by quotes and ends with /n. So it looks like this: "{/* cspell:ignore hellllooooo, ayyyyy */}/n" | |
| 1. Ignore the word in the local markdown file by adding a comment to the file, like below. The word is not case-sensitive, and the comment can be placed anywhere (inside a markdown cell, in the source part). Note that in the text editor, each line is surrounded by quotes and ends with \n. So it looks like this: "{/* cspell:ignore hellllooooo, ayyyyy */}\n" |
There was a problem hiding this comment.
@beckykd this is still unsolved. Frank's suggestion only fixed a typo and didn't yet apply my suggestion
Co-authored-by: Frank Harkins <[email protected]>
…tion into beckykd-patch-2
Eric-Arellano
approved these changes
Jan 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.